home *** CD-ROM | disk | FTP | other *** search
/ The PC-SIG Library 10 / The PC-Sig Library - Shareware for the IBM PC and Compatibles (PC-SIG)(Tenth Edition Disks 1-2804)(1991).iso / PC_SIGCD / 22 / 1 / DISK2214.ZIP / WEDIT.DOC < prev    next >
Text File  |  1988-06-15  |  18KB  |  398 lines
  1.   =================== READ_ME.WED: Describes WEDIT.EXE ====================
  2.  
  3.   Accompanies:  Quicksilver Diamond Release (1.2c), July 1988
  4.                 Quicksilver User's Reference, 4th Edition
  5.  
  6.   Contents:     Introduction to WEDIT
  7.                 WEDIT System Files
  8.                 Installing WEDIT
  9.                 Starting WEDIT
  10.                 The WEDIT Screen
  11.                 The WEDIT Selection Bar
  12.                 File Editing Keys
  13.                   Cursor Movement Keys
  14.                   Text Insertion Keys
  15.                   Movement or Insertion Keys
  16.                   Text Deletion Keys
  17.                   Block Manipulation Keys
  18.                   Text Search Keys
  19.                   Disk Read and Write Keys
  20.                   "Type" Command Keys
  21.                   Display Selection Bar Keys
  22.  == Introduction to WEDIT ==
  23.  WEDIT is WordTech Systems' stand-alone text editor. It is similar to dBASE
  24.  III Plus and dBXL's MODIFY COMMAND. WEDIT creates or displays a specified
  25.  command file and allows the editing of its contents. With WEDIT, you do not
  26.  need to purchase dBASE III Plus, dBXL, or your own text editor to modify
  27.  the text files you use with Quicksilver. WEDIT offers a number of features
  28.  that facilitate file editing, including full-screen editing, block text
  29.  manipulation, string searches, and disk reads and writes.
  30.  
  31.  WEDIT can be used to edit files within windows in Quicksilver-compiled
  32.  applications. WEDIT is the default text editor used to edit the contents of
  33.  memo fields when running Quicksilver-compiled applications.
  34.  
  35.  WEDIT may be freely distributed in conjunction with Quicksilver-compiled
  36.  programs for use in editing memo files. WordTech Systems places no license
  37.  restrictions upon use of WEDIT.EXE in conjunction with Quicksilver-compiled
  38.  applications.
  39.  
  40.  WEDIT uses 79K of memory plus the amount of memory needed for your text
  41.  file. WEDIT can create and access files up to 32K.
  42.  
  43.  == WEDIT System Files ==
  44.  
  45.  The following files are included with WEDIT:
  46.  
  47.  Filename            Contains
  48.  ------------        -------------------------------------------------
  49.  WEDIT.EXE           The WEDIT text editor
  50.  WINSTALL.EXE        WEDIT's installation program
  51.  WINSTALL.DAT        WEDIT's installation data
  52.  READ_ME.WED         This file--describes how to install and use WEDIT
  53.  
  54.  Copy these files onto a directory on your computer's hard disk.
  55.  
  56.  == Installing WEDIT ==
  57.  
  58.  Depending on your computer, to use WEDIT, you may need to run WINSTALL,
  59.  WEDIT's installation program. WINSTALL asks a series of questions about
  60.  your computer. The information you provide enables WEDIT to display screens
  61.  compatible with your computer and to read data from your keyboard.
  62.  
  63.  If your computer is not 100% IBM PC-compatible, you must run WINSTALL to be
  64.  able to use WEDIT. If your computer is an IBM PC or is 100% IBM PC-
  65.  compatible, you do not need to run WINSTALL. However, some computers will
  66.  benefit from WINSTALL's optimization of WEDIT's screen displays.
  67.  
  68.  To invoke WINSTALL, enter the following at the DOS prompt:
  69.  
  70.  WINSTALL
  71.  
  72.  Then answer the questions that WINSTALL displays on the screen. If you wish
  73.  to exit WINSTALL at any time, press Ctrl-C.
  74.  
  75.  If you decide not to run WINSTALL, you do not need to enter the WINSTALL
  76.  command. After copying the WEDIT files onto your computer's hard disk,
  77.  simply start WEDIT as described below.
  78.  
  79.  == Starting WEDIT ==
  80.  
  81.  The syntax for invoking WEDIT from the DOS prompt is as follows:
  82.  
  83.  WEDIT [<filename>] [-W<coordinates>] [-L<line #>] [-F]
  84.  
  85.  where <filename> is the name of either an existing file you wish to edit or
  86.  a file you wish to create. You must enter the filename extension, if any.
  87.  If you wish, you can also include a full path name to specify a drive
  88.  and/or directory different from the current drive and/or directory. If you
  89.  do not specify a filename at the DOS prompt, WEDIT prompts you for one.
  90.  
  91.  The -W option specifies coordinates of a Quicksilver window within which
  92.  WEDIT will work. The default is window 0 (i.e. the regular screen
  93.  coordinates).
  94.  
  95.  -L specifies a line number at which to commence editing. The default
  96.  beginning line number is line 1.
  97.  
  98.  -F specifies that you wish to edit a full file. If this option is not used,
  99.  WEDIT will only edit as much of a file as can fit in a single window (of
  100.  the default size, or as specified with the -W option). This option
  101.  specifies that WEDIT is to allow editing of a full file, rather than a
  102.  single window-sized page.
  103.  
  104.  == The WEDIT Screen ==
  105.  
  106.  After you invoke WEDIT, the following screen display appears:
  107.  
  108.  anyfile.prg          total lines = 1              line=1   col=0
  109.  * * * top of file * * *
  110.  
  111.  * * * end of file * * *
  112.  
  113.  If the file you specify when you invoke WEDIT does not exist, WEDIT creates
  114.  it. If the file you specify when you invoke WEDIT already exists, WEDIT
  115.  displays it between the "* * * top of file * * * " and "* * * end of file *
  116.  * *" markers. In either case, the cursor is positioned on line 1 and column
  117.  0 of the file. WEDIT awaits your editing instructions. You cannot edit the
  118.  "* * * top of file * * *" and "* * * end of file * * *" markers, although
  119.  you can position the cursor in these lines.
  120.  
  121.  At the top of the screen, WEDIT displays the name of the file you are
  122.  editing, the total number of lines in the file, and the current line and
  123.  column numbers.
  124.  
  125.  You can type as many as 254 characters on a line.
  126.  
  127.  == The WEDIT Selection Bar ==
  128.  
  129.  To simplify editing, WEDIT has a selection bar. Press Esc to display it.
  130.  
  131.  ========= WordTech Editor ==============================================
  132.   Line #     Bottom     Top    Read Write       Find       Next    Quit
  133.   Go to a specified line number.
  134.  ========================================================================
  135.  
  136.  The top line of the selection bar displays eight options. Each option
  137.  performs a specific editing action when selected. After you press Esc to
  138.  invoke the selection bar, the highlight displays on the first option, "Line
  139.  #". As you maneuver the highlight from one option to another on the
  140.  selection bar by pressing the Right Arrow and Left Arrow keys, the talker
  141.  line below the options changes. The talker line describes the action that
  142.  will occur if you select the highlighted option. For example, "Go to a
  143.  specified line number." is the talker line describing the action that will
  144.  occur if you select "Line #".
  145.  
  146.  You can select an option from the selection bar by two different methods.
  147.  You can press the first letter of an option to select it. Or, you can use
  148.  the Right Arrow and Left Arrow keys to move the highlight to an option, and
  149.  then press the Enter key to select that option.
  150.  
  151.  Each selection bar option and the action that occurs if you select the
  152.  option are listed below:
  153.  
  154.  Line #    Displays "Edit line number:" and advances the cursor to the line
  155.            number you specify.
  156.  
  157.  Bottom    Advances the cursor to the beginning of the last line of the file
  158.            (the line before the "* * * end of file * * *" marker).
  159.  
  160.  Top       Moves the cursor to the beginning of the first line of the file
  161.            the line after the "* * * top of file * * *" marker).
  162.  
  163.  Read      Prompts "File name:" and copies the contents of the file you
  164.            specify into the current file at the current cursor position.
  165.            "Read" is equivalent to Ctrl-KR, described below.
  166.  
  167.  Write     Prompts "File name:" and displays the current filename as the
  168.            default. "Write" saves the file under the name you specify. By
  169.            either entering a new filename or pressing the Enter key to
  170.            accept the default filename, you ensure that changes are written
  171.            to disk. (Selecting "Write" is similar to selecting "Quit"
  172.            followed by "Save". The difference is that "Write" leaves the
  173.            current file displayed for editing, whereas "Quit" followed by
  174.            "Save" exits the text editor to DOS.) "Write" is equivalent to
  175.            Ctrl-KW, described below.
  176.  
  177.  Find      Prompts "Search string" and searches from the beginning of the
  178.            file for a match to the string you specify. Note that "Find" is
  179.            not case-sensitive; it does not distinguish between upper- and
  180.            lower-case letters. "Find" is equivalent to Ctrl-KF, described
  181.            below.
  182.  Next      Searches for the next occurrence of the last string you specified
  183.            with "Find". "Next" is equivalent to Ctrl-KL, described below.
  184.  
  185.  Quit      Offers two options, "Save" and "Abandon", that exit the text
  186.            editor to DOS. Select "Save" to save the file. "Save" then
  187.            prompts "File name:" with the filename you specified when
  188.            invoking WEDIT as the default. You can save the file under the
  189.            default filename by pressing the Enter key, or you can enter
  190.            another filename. "Save" then saves the file and exits the text
  191.            editor to DOS. To exit without saving changes, select "Abandon".
  192.            If you have not made any changes to the current file, "Abandon"
  193.            exits the text editor to DOS. If you have made changes to the
  194.            current file, "Abandon" prompts "Changes have been made. Do you
  195.            still wish to Abandon?". Enter Y to exit the text editor to DOS
  196.            without saving the changes; enter N to re-activate the current
  197.            file.
  198.  
  199.  == File Editing Keys ==
  200.  
  201.  File editing keys or key combinations and their effects are grouped as
  202.  follows:
  203.  
  204.   o  Cursor Movement Keys
  205.   o  Text Insertion Keys
  206.   o  Movement or Insertion Keys
  207.   o  Text Deletion Keys
  208.   o  Block Manipulation Keys
  209.   o  Text Search Keys
  210.   o  Disk Read and Write Keys
  211.   o  "Type" Command Keys
  212.   o  Display Selection Bar Keys
  213.  
  214.  = Cursor Movement Keys =
  215.  
  216.  Up Arrow or Ctrl-E       Moves the cursor up one line.
  217.  
  218.  Down Arrow or Ctrl-X     Moves the cursor down one line.
  219.  or Ctrl-J
  220.  
  221.  Left Arrow or Ctrl-S     If the cursor is not at the beginning of the line,
  222.                           moves the cursor left one character. If the cursor
  223.                           is at the beginning of the line, moves the cursor
  224.                           to the beginning of the previous line.
  225.  
  226.  Right Arrow or Ctrl-D    Moves the cursor right one character.
  227.  or Ctrl-L
  228.  
  229.  Home or Ctrl-A           Moves the cursor left one word.
  230.  
  231.  End or Ctrl-F            Moves the cursor right one word.
  232.  
  233.  Ctrl-Right Arrow         Moves the cursor to the end of the current line.
  234.  or Ctrl-B
  235.  
  236.  Ctrl-Left Arrow          Moves the cursor to the beginning of the current
  237.  or Ctrl-Z                line.
  238.  
  239.  Pg Dn                    Moves the cursor down 23 lines.
  240.  
  241.  Pg Up                    Moves the cursor up 23 lines.
  242.  
  243.  
  244.  = Movement or Insertion Keys =
  245.  
  246.  Enter or Ctrl-M          If insert mode is not active, moves the cursor to
  247.                           the beginning of the subsequent line. If insert
  248.                           mode is active, splits the current line at the
  249.                           cursor and moves the cursor to the beginning of
  250.                           the subsequent line. If the cursor is at the end
  251.                           of the line before the "* * * end of file * * *"
  252.                           marker, inserts a blank line, regardless of the
  253.                           status of insert mode. (Insert mode is described
  254.                           under Ins below.)
  255.  
  256.  Tab or Ctrl-I            If insert mode is not active, moves the cursor
  257.                           four characters to the right. If insert mode is
  258.                           active, inserts four spaces and moves the cursor
  259.                           four characters to the right. (Insert mode is
  260.                           described under Ins below.)
  261.  
  262.  = Text Insertion Keys =
  263.  
  264.  Ins or Ctrl-V            Toggles insert mode on and off. When you start
  265.                           WEDIT, insert mode is not active; the character
  266.                           you type overwrites the character at the current
  267.                           cursor position. Once you press the Ins key,
  268.                           insert mode is active; the character you type is
  269.                           inserted at the current cursor position. (When
  270.                           insert mode is active, the cursor appears taller
  271.                           and flashes more rapidly.)
  272.  
  273.  Ctrl-N                   Inserts a blank line at the current line, moves
  274.                           the cursor to the beginning of the blank line and
  275.                           moves the current line down one row.
  276.  
  277.  Alt-A                    Inserts a blank line below the current line and
  278.                           moves the cursor to the beginning of the new blank
  279.                           line.
  280.  
  281.  Alt-S                    Splits the current line at the cursor and moves
  282.                           the cursor to the beginning of the new line.
  283.  
  284.  = Text Deletion Keys =
  285.  
  286.  Del or Ctrl-G            Deletes the character under the cursor.
  287.  
  288.  Backspace or Ctrl-H      Deletes the character left of the cursor and moves
  289.                           the cursor one character to the left.
  290.  
  291.  Ctrl-Y or Alt-D          Deletes the current line.
  292.  
  293.  Ctrl-T                   Deletes from the character under the cursor to the
  294.                           beginning of the next word.
  295.  
  296.  Alt-J                    Deletes from the character under the cursor to the
  297.                           end of the current line and joins the subsequent
  298.                           line with the current line.
  299.  
  300.  
  301.  = Block Manipulation Keys =
  302.  
  303.  Alt-L                    Highlights a block (a line or group of lines) for
  304.                           manipulation. To highlight a block, move the
  305.                           cursor to a line and press Alt-L. Then, if you
  306.                           wish to highlight more than one line, move the
  307.                           cursor to another line and press Alt-L. WEDIT
  308.                           highlights the block beginning with the first line
  309.                           you selected through the last line you selected.
  310.  
  311.  Alt-C                    Copies a highlighted block to the line after the
  312.                           current line and removes the highlight from the
  313.                           original block.
  314.  
  315.  Alt-K                    Copies a highlighted block to the line after the
  316.                           current line and leaves the original block
  317.                           highlighted.
  318.  
  319.  Alt-M                    Moves a highlighted block to the line after the
  320.                           current line.
  321.  
  322.  Alt-G                    Deletes the highlighted block.
  323.  
  324.  Alt-U                    Removes the highlight from the currently
  325.                           highlighted block.
  326.  
  327.  = Text Search Keys =
  328.  
  329.  Ctrl-KF                  Prompts "Search string" and searches from the
  330.                           beginning of the file for a match to the string
  331.                           you specify. Note that Ctrl-KF is not case-
  332.                           sensitive; it does not distinguish between upper-
  333.                           and lower-case letters. Pressing Ctrl-KF is
  334.                           equivalent to selecting "Find" on the selection
  335.                           bar, described above.
  336.  
  337.  Ctrl-KL                  Searches for the next occurrence of the last
  338.                           string you specified with Ctrl-KF or "Find" on the
  339.                           selection bar. Pressing Ctrl-KL is equivalent to
  340.                           selecting "Next" on the selection bar, described
  341.                           above.
  342.  
  343.  = Disk Read and Write Keys =
  344.  
  345.  Ctrl-KR                  Prompts "File name:" and copies the contents of
  346.                           the file you specify into the current file at the
  347.                           current cursor position. Pressing Ctrl-KR is
  348.                           equivalent to selecting "Read" on the selection
  349.                           bar, described above.
  350.  
  351.  Ctrl-KW                  Prompts "File name:" and displays the current
  352.                           filename as the default. Ctrl-KW saves the file
  353.                           under the name you specify. By either entering a
  354.                           new filename or pressing the Enter key to accept
  355.                           the default filename, you ensure that changes are
  356.                           written to disk. Pressing Ctrl-KW is equivalent to
  357.                           selecting "Write" on the selection bar, described
  358.                           above.
  359.  
  360.  = "Type" Command Keys =
  361.  
  362.  When you press one of the following function keys, WEDIT "types" a commonly
  363.  used dBASE or dBXL command at the current cursor position. If insert mode
  364.  is not active, WEDIT overwrites any text beginning at the current cursor
  365.  position with the command and advances the cursor to the beginning of the
  366.  subsequent line. If insert mode is active, WEDIT inserts the command at the
  367.  current cursor position, splits the line after the command, and advances
  368.  the cursor to the beginning of the subsequent line. (Insert mode is
  369.  described under Ins above.)
  370.  
  371.  Key      Command WEDIT "Types"
  372.  ---      ---------------------
  373.  F2       intro
  374.  F3       list
  375.  F4       dir
  376.  F5       display structure
  377.  F6       display status
  378.  F7       display memory
  379.  F8       display
  380.  F9       append
  381.  = Display Selection Bar Keys =
  382.  
  383.  Ctrl-Pg Up or Ctrl-W     Displays the selection bar with "Quit"
  384.                           highlighted. If you then select "Quit", "Save"
  385.                           appears as the default.
  386.  
  387.  Ctrl-Pg Dn or Ctrl-Home  Displays the selection bar with "Quit"
  388.  or Ctrl-] or Ctrl-Q      highlighted. If you then select "Quit", "Abandon"
  389.                           appears as the default.
  390.  
  391.  Esc or Ctrl-[            If the selection bar is not already displayed,
  392.                           displays the selection bar with "Line #"
  393.                           highlighted. If the selection bar is already
  394.                           displayed, removes the selection bar from the
  395.                           screen.
  396.  
  397.  ======================== End of READ_ME.WED File ========================
  398.